Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(www): enable providers to send custom error responses via the dynamic key #1830

Merged
merged 25 commits into from
Mar 13, 2024

Conversation

daniellacosse
Copy link
Contributor

@daniellacosse daniellacosse commented Feb 2, 2024

This PR enables service providers to return an error object to inform the end user about something wrong with their dynamic key or server connection. Service providers could then volunteer contact information via this error message.
Screenshot 2024-04-15 at 3 12 45 PM

@daniellacosse daniellacosse requested review from fortuna and a team as code owners February 2, 2024 01:52
@github-actions github-actions bot added the size/M label Feb 2, 2024
Copy link

codecov bot commented Feb 2, 2024

Codecov Report

Attention: Patch coverage is 60.00000% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 32%. Comparing base (8ec1aae) to head (cbcf94c).

Files Patch % Lines
...line_server_repository/access_key_serialization.ts 71% 2 Missing ⚠️
src/www/model/errors.ts 33% 2 Missing ⚠️
Additional details and impacted files
@@          Coverage Diff           @@
##           master   #1830   +/-   ##
======================================
- Coverage      32%     32%   -1%     
======================================
  Files          45      45           
  Lines        2610    2620   +10     
  Branches      337     340    +3     
======================================
+ Hits          859     860    +1     
- Misses       1751    1760    +9     
Flag Coverage Δ
apple 15% <ø> (ø)
ios 15% <ø> (ø)
maccatalyst 15% <ø> (ø)
macos 15% <ø> (ø)
unittests 32% <60%> (-1%) ⬇️
www 40% <60%> (-1%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@daniellacosse daniellacosse changed the title proposal(www): add a provider message and contact option to the access key proposal(www): enable providers to communicate through the access key Feb 2, 2024
@daniellacosse daniellacosse added needs UX needs test Pull requests that require tests javascript Pull requests that update Javascript code user support & communication needs discussion and removed needs test Pull requests that require tests labels Feb 2, 2024
@fortuna
Copy link
Collaborator

fortuna commented Feb 5, 2024

We need to better understand the trade-offs between the different approaches, which also included a client response and a Client API.
During planning, we decided we needed a document for discussion.

There are also open questions regarding what format we should use, and what the UI should look like, but they can be decoupled from the chosen approach.

@github-actions github-actions bot added size/S and removed size/M labels Mar 6, 2024
@github-actions github-actions bot added size/M and removed size/S labels Mar 6, 2024
@daniellacosse daniellacosse changed the title proposal(www): enable providers to communicate through the access key proposal(www): enable providers to send custom error responses Mar 6, 2024
@daniellacosse daniellacosse changed the title proposal(www): enable providers to send custom error responses proposal(www): enable providers to send custom error responses via the dynamic keyq Mar 6, 2024
@daniellacosse daniellacosse changed the title proposal(www): enable providers to send custom error responses via the dynamic keyq proposal(www): enable providers to send custom error responses via the dynamic key Mar 6, 2024
@github-actions github-actions bot added size/XS and removed size/S labels Mar 7, 2024
src/www/app/outline_server_repository/server.ts Outdated Show resolved Hide resolved
src/www/app/tunnel.ts Outdated Show resolved Hide resolved
Copy link
Collaborator

@fortuna fortuna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome, and it will be super helpful to providers. Thanks for implementing it!

It's ok to merge, but please test the functionality to make sure it's working end-to-end after all the changes.

@fortuna
Copy link
Collaborator

fortuna commented Mar 12, 2024

We also need to think about communicating the new feature in the next release, and perhaps add that to the wiki.

@daniellacosse daniellacosse removed the needs test Pull requests that require tests label Mar 13, 2024
@daniellacosse daniellacosse merged commit 70df767 into master Mar 13, 2024
19 of 21 checks passed
@daniellacosse daniellacosse deleted the daniellacosse/provider_message_and_contact branch March 13, 2024 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
javascript Pull requests that update Javascript code size/XS user support & communication
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants